usbuart6.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/

 
#ifndef USBUART6_H
#define USBUART6_H
 
#ifdef __cplusplus
extern "C"{
#endif

#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_uart.h"




#define USBUART6_TX_DRV_BUFFER_SIZE    200
#define USBUART6_RX_DRV_BUFFER_SIZE    200
 // usbuart6_cmd



#define USBUART6_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.en = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.cts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.rts = MIKROBUS( mikrobus, MIKROBUS_INT );
 // usbuart6_map // usbuart6

typedef struct
{
    // Output pins
    digital_out_t en;               
    digital_out_t cts;              
 
    // Input pins
    digital_in_t rts;               
 
    // Modules
    uart_t uart;                    
 
    // Buffers
    uint8_t uart_rx_buffer[ USBUART6_RX_DRV_BUFFER_SIZE ];  
    uint8_t uart_tx_buffer[ USBUART6_TX_DRV_BUFFER_SIZE ];  
 
} usbuart6_t;

typedef struct
{
    // Communication gpio pins
    pin_name_t rx_pin;              
    pin_name_t tx_pin;              
 
    // Additional gpio pins
    pin_name_t en;                  
    pin_name_t cts;                 
    pin_name_t rts;                 
 
    // Static variable
    uint32_t         baud_rate;     
    bool             uart_blocking; 
    uart_data_bits_t data_bit;      
    uart_parity_t    parity_bit;    
    uart_stop_bits_t stop_bit;      
 
} usbuart6_cfg_t;

typedef enum
{
    USBUART6_OK = 0,
    USBUART6_ERROR = -1
 
} usbuart6_return_value_t;


void usbuart6_cfg_setup ( usbuart6_cfg_t *cfg );

err_t usbuart6_init ( usbuart6_t *ctx, usbuart6_cfg_t *cfg );

err_t usbuart6_generic_write ( usbuart6_t *ctx, uint8_t *data_in, uint16_t len );

err_t usbuart6_generic_read ( usbuart6_t *ctx, uint8_t *data_out, uint16_t len );

void usbuart6_enable_device ( usbuart6_t *ctx );

void usbuart6_disable_device ( usbuart6_t *ctx );

void usbuart6_set_cts_pin ( usbuart6_t *ctx, uint8_t state );

uint8_t usbuart6_get_rts_pin ( usbuart6_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // USBUART6_H
 // usbuart6
 
// ------------------------------------------------------------------------ END